Foxit PDF SDK
FoxitPDFSDKPython2.Md2PDF Class Reference

Inherits FoxitPDFSDKPython2._object.

Static Public Member Functions

def ConvertFromMarkdown (src_markdown_file_path, src_file_password, saved_pdf_path, setting_data)
 Convert a Markdown format file to a PDF file. More...
 
def GetVersion ()
 Get the version of Foxit PDF Conversion SDK. More...
 
def Initialize (library_path)
 Initialize the Md2PDF module by loading the Foxit PDF Conversion SDK library. More...
 
def Release ()
 Release the Md2PDF module and unload the Foxit PDF Conversion SDK library. More...
 

Detailed Description

This class can be used to convert Markdown format files to PDF files.

Note
Before using this class, please call FoxitPDFSDKPython2.Md2PDF.Initialize to load the Foxit PDF Conversion SDK library. After all conversions are done, call FoxitPDFSDKPython2.Md2PDF.Release to unload the library.

Member Function Documentation

◆ ConvertFromMarkdown()

FoxitPDFSDKPython2.Md2PDF.ConvertFromMarkdown (   src_markdown_file_path,
  src_file_password,
  saved_pdf_path,
  setting_data 
)
static

Convert a Markdown format file to a PDF file.

Function FoxitPDFSDKPython2.Md2PDF.Initialize must be called successfully before calling this function.

Parameters
[in]src_markdown_file_pathPath of a Markdown format file. This should not be an empty string.
[in]src_file_password(Reserved) Password for the input file. Please pass an empty string.
[in]saved_pdf_pathPath of the saved PDF file as conversion result. This should not be an empty string.
[in]setting_dataA Md2PDFSettingData object which is used for converting. Default value: Md2PDFSettingData default values.
Returns
true means success, while false means failure.

◆ GetVersion()

FoxitPDFSDKPython2.Md2PDF.GetVersion ( )
static

Get the version of Foxit PDF Conversion SDK.

This function should be called after the function FoxitPDFSDKPython2.Md2PDF.Initialize has been called successfully.

Returns
A string which contains the version information of Foxit PDF Conversion SDK.

◆ Initialize()

FoxitPDFSDKPython2.Md2PDF.Initialize (   library_path)
static

Initialize the Md2PDF module by loading the Foxit PDF Conversion SDK library.

Before using FoxitPDFSDKPython2.Md2PDF.ConvertFromMarkdown , please call this function first with the path to the Foxit PDF Conversion SDK library. Function FoxitPDFSDKPython2.Library.Initialize must already have been called successfully with a key including "Md2PDF" module right.

Parameters
[in]library_pathPath to the Foxit PDF Conversion SDK dynamic library (e.g. "fpdfconversionsdk_win64.dll" on Windows, "libfpdfconversionsdk.so" on Linux). This should not be an empty string.
Returns
None.

◆ Release()

FoxitPDFSDKPython2.Md2PDF.Release ( )
static

Release the Md2PDF module and unload the Foxit PDF Conversion SDK library.

This function should be called after all FoxitPDFSDKPython2.Md2PDF.ConvertFromMarkdown calls are finished. It must be called after FoxitPDFSDKPython2.Md2PDF.Initialize has been called successfully.

Returns
None.